This AgileShape can be used to represent a Manual (i.e. human input required) activity that must be completed sequentially by 1 or more participants. It is designed to be used as part of a “loop” in a process, so that the process flow will keep returning to this AgileShape until a sufficient number of participants have completed the activity (or until some other condition exits the loop). The UI associated with the Task determines where the value(s) associated with the UI are stored (e.g. an Approval value).
NOTE: This AgileShape is a specialized sub-type of the AgileWork AgileShape. Refer to the documentation for the AgileWork AgileShape for additional information about the properties and behavior that this sub-type inherits from the AgileWork AgileShape.
NOTE: The Dynamic Sequential Approval shape doesn’t have a property that determines where the value(s) associated with the UI are stored. This feature would limit the types of UIs that could be used with that shape.
Here is a simple example of how this AgileShape is typically used:
Design-Time Properties
NOTE: Since this AgileShape is a specialized sub-type of the AgileWork AgileShape, all of the standard properties supported by the AgileWork AgileShape are also supported by this AgileShape. Since they are already documented elsewhere, the standard AgileWork properties are not documented in this section. Refer to the documentation for the AgileWork AgileShape for information about the standard AgileWork properties. Additional design-time properties (other than the standard AgileWork properties) that are specific to this AgileShape are documented below.
UserDefinedProperties
NOTE: This property has no effect unless custom code or custom modules are created that use the specified values at runtime.
This property allows the process modeler to configure initial ClientData values that will be associated with the AgileShape’s associated task(s) at runtime. This is basically a way of allowing you to specify a set of name/value pairs that are passed to your Web page via an object called a WorkItem. This is an alternative to passing data via URL parameters. In your Web page you can retrieve this data via the ClientData property of the WorkItem. It is then up to you to decide how to use the data.
Click the Ellipses button to open the configuration dialog.
Approvers
Default value: $Approvers
This property specifies the name of the custom attribute that (initially) contains the user names of the approvers. The usernames should be separated by a semicolon. Each time this AgileShape is entered at runtime, the AgileShape will assign a task to the first username specified by this property. Then the custom attribute associated with this property will be modified to remove the username so that the next username will be assigned the task during the next iteration through the loop.
NOTE: The value of this property should be the name of a custom attribute. The value of the custom attribute should be initialized elsewhere (e.g. using a Update Custom Attributes AgileShape).
LoopCondition
Default value: $HasMoreApprover
This property specifies the name of the custom attribute that will be updated each time the AgileShape is exited to indicate whether more Approvers are still waiting to be assigned the task. The value of the specified custom attribute should be checked (using a SingleCondition AgileShape within the loop) to determine whether the loop should be exited or not.
NOTE: The value of this property should be the name of a custom attribute. The value of the custom attribute should be initialized elsewhere (e.g. using a C# Snippet AgileShape).
Debug
Default value: True
For AgileShapes that support it, this property determines whether the AgileShape will log additional progress and debugging messages to the AgilePoint Server log file at runtime. This property can be set to the following specific values:
- False
This value indicates that the AgileShape will not log additional progress and debugging messages to the AgilePoint Server log file at runtime.
- True
This value indicates that the AgileShape will log additional progress and debugging messages to the AgilePoint Server log file at runtime. These messages are often helpful in verifying that the AgileShape is functioning properly and/or with troubleshooting any problems or suspected problems with the AgileShape’s runtime behavior or configuration.
EnabledExchangeServer
Default value: False
Refer to the Web Form AgileShape’s documentation for additional information.
ExchangeServer
Refer to the Web Form AgileShape’s documentation for additional information.